<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>CompressedTextureLoader - Three.js Docs</title>
	<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
	<script src="../scripts/highlight.min.js"></script>
	<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
	<link type="text/css" rel="stylesheet" href="../styles/page.css">
</head>
<body>
		<p class="inheritance" translate="no"><a href="Loader.html">Loader</a> → </p>
	<h1 translate="no">CompressedTextureLoader</h1>
		<section>
			<header>
				<div class="class-description"><p>Abstract base class for loading compressed texture formats S3TC, ASTC or ETC.
Textures are internally loaded via <a href="FileLoader.html">FileLoader</a>.</p>
<p>Derived classes have to implement the <code>parse()</code> method which holds the parsing
for the respective format.</p></div>
			</header>
			<article>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="CompressedTextureLoader" translate="no">new <a href="#CompressedTextureLoader">CompressedTextureLoader</a><span class="signature">( manager : <span class="param-type"><a href="LoadingManager.html">LoadingManager</a></span> )</span> <span class="type-signature">(abstract) </span></h3>
					<div class="method">
						<div class="description">
							<p>Constructs a new compressed texture loader.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>manager</strong>
									</td>
									<td class="description last">
										<p>The loading manager.</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
				</div>
				<h2 class="subsection-title">Methods</h2>
					<h3 class="name name-method" id="load" translate="no">.<a href="#load">load</a><span class="signature">( url : <span class="param-type">string</span>, onLoad : <span class="param-type">function</span>, onProgress : <span class="param-type"><a href="global.html#onProgressCallback">onProgressCallback</a></span>, onError : <span class="param-type"><a href="global.html#onErrorCallback">onErrorCallback</a></span> )</span><span class="type-signature"> : <a href="CompressedTexture.html">CompressedTexture</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Starts loading from the given URL and passes the loaded compressed texture
to the <code>onLoad()</code> callback. The method also returns a new texture object which can
directly be used for material creation. If you do it this way, the texture
may pop up in your scene once the respective loading process is finished.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>url</strong>
									</td>
									<td class="description last">
										<p>The path/URL of the file to be loaded. This can also be a data URI.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong>onLoad</strong>
									</td>
									<td class="description last">
										<p>Executed when the loading process has been finished.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong>onProgress</strong>
									</td>
									<td class="description last">
										<p>Executed while the loading is in progress.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong>onError</strong>
									</td>
									<td class="description last">
										<p>Executed when errors occur.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#load">Loader#load</a></dt>
						</dl>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> The compressed texture.</dt>
						</dl>
					</div>
				<h2 class="subsection-title">Type Definitions</h2>
				<div class="member">
					<h3 class="name" id="~TexData" translate="no">.<a href="#~TexData">TexData</a> </h3>
					<div class="description">
						<p>Represents the result object type of the <code>parse()</code> method.</p>
					</div>
<table class="props">
	<tbody>
		<tr>
				<td class="name">
					<strong>width</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The width of the base mip.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>height</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The width of the base mip.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>isCubemap</strong>
						<br>
<span class="param-type">boolean</span>
				</td>
			<td class="description last">
				<p>Whether the data represent a cubemap or not.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>mipmapCount</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The mipmap count.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>mipmaps</strong>
						<br>
<span class="param-type">Array.&lt;{data:TypedArray, width:number, height:number}></span>
				</td>
			<td class="description last">
				<p>An array holding the mipmaps.
Each entry holds the data and the dimensions for each level.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>format</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The texture format.</p>
			</td>
		</tr>
	</tbody>
</table>
				</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/src/loaders/CompressedTextureLoader.js" translate="no" target="_blank" rel="noopener">src/loaders/CompressedTextureLoader.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>